home *** CD-ROM | disk | FTP | other *** search
/ Grand Slam 3 / Grand Slam 3.iso / 004 / brecon93.arj / BRECON.DOC next >
Text File  |  1995-02-18  |  11KB  |  243 lines
  1.          -= BRECon Interplanetary Bulletin Generator version 0.093 =-
  2.                          -= (C)1995 HighwayWare =-
  3.  
  4.                       -= Documentation and Users Guide =-
  5.  
  6.  
  7.                               -- DISCLAIMER --
  8.  
  9. |   This utility (BRECon) is FREEWARE. Therefore, USE IT AT YOUR OWN RISK.   |
  10. |  There are NO warranties or guarantees of any concievable form associated  |
  11. |  with this program, other than the fact that it WILL occupy space on your  |
  12. |   storage media, be it floppy, hard, tape, WORM, 8-track, whatever. :>     |
  13. |                                                                            |
  14. |     If it screws up, feel free to delete it and send me nasty netmail.     |
  15.  
  16.  
  17. -- System Requirements
  18.  
  19.     BRECon now will function on 8088/8086 systems. Now only about 300k
  20.     of memory needed, irregardless of League size.
  21.  
  22. -- Overview
  23.  
  24.   
  25.   Ok, it's "just another BRE bulletin generator". (yawn). Yep, that's it.
  26.  
  27.   Yeah, but it's one that WORKS with the new (v0.961+) version of BRE! Now 
  28.  that's a plus. (version 0.07 changed to work propely with ßeta versions of
  29.  BRE)
  30.  
  31.   I used to use BREMIL and BRESPY (copyrighted by their repective authors)
  32.  to make my IP "master" and "bulletin" lists.  But since the data formats
  33.  for BRE changed (0.956 to 0.960), those old, but excellent, utilities no
  34.  longer functioned as designed.  So I fired up TP and coded up my own. And
  35.  there were a few idiosyncracies about those two progs that bugged me, so
  36.  I made what I consider to be a few improvements.
  37.  
  38.  One - a SINGLE copy of BRECon can function for as many leagues as you run.
  39.  No more having umpteen copies of the same bulletin generator wasting your
  40.  valuable HD space.
  41.  
  42.  Two - SPEED.  BRECon is FAST. Period. All sorting is done entirely in memory,
  43.  and disk access is kept to a bare minimum.  No more 30-second delays while
  44.  your huge BRE league is processed. (that bugged me the most about those old
  45.  utilities)
  46.  
  47.  Three - ease of setup.  BRECon is entirely commandline driven. No RESOURCE.DAT
  48.  to add parameters to. (save for bulletin names, BRE itself needs that.)
  49.  
  50.  Four - Elimination of "dead" data.  How many BRE bulletin generators have you
  51.  seen make seemingly endless screens full of data on systems that haven't even
  52.  RECONNED yet! This, in my opinion, is both lazy programming and a waste of 
  53.  hard drive space and player time. This baby here only produces bulletins for
  54.  systems that actually HAVE something to report to you.  No more waste.
  55.  
  56.  
  57.  
  58. -- Nitty Gritty (or how to use de dang thing)
  59.  
  60.  
  61.  For a quick look see on how to use it, just type BRECON /? at the DOS prompt.
  62.  A help screen will pop up with the info you need. But since you took the 
  63.  trouble to load up your text editor or whatever to read this file, I'll tell
  64.  ya how to use it now.
  65.  
  66.  
  67.  BRE IP (InterPlanetary) games are USUALLY won or lost based on which "planet"
  68.  (BBS) achieves the highest cumulative score. Some Leagues use different 
  69.  values, such as region count, or possibly Networth.  ....I assume you know 
  70.  this already.  What BRECon does is sort the ENTIRE league, by whatever "value"
  71.  you see fit, and then produce a "master list" and/or "bulletin list" of said
  72.  League, in order, from #1 to #whatever. Options for League Sorting are: by
  73.  Regions (default), Score, Networth, and System Number.  However, due to some
  74.  SysOps and users input, "Realm Sorting" has also been implemented. Irregard-
  75.  less of what type of "League Sort" you use, you can specify one of four "Realm 
  76.  Sort" types, which are identical to the League sort types. Confused? Don't be.
  77.  
  78.  Here's an example commandline for BRECon:
  79.  
  80.                BRECON p=c:\doors\bre253 ls rr both b#
  81.  
  82.   ..that just told BRECon to sort League 253 by Score, Realms by Regions, and
  83.   to produce both BULLETIN.LST and BRE_253.ANS/.ASC bulletin files, using nu-
  84.   meric format.
  85.  
  86.  Now I bet you're confused :>  Read on...
  87.  
  88.  
  89.  Let me explain in detail the parameters BRECON needs.
  90.  
  91.  One: The PATH to the BRE game you want to produce bulletins for. Precede the 
  92.       complete path with a 'p=', just like in the above example.
  93.  
  94.  Two: Sorting options - Four types here, with two applications. Use 'L' for
  95.      'League', and 'R' for 'Realm', with the appropriate 'field' designator
  96.       after it. I.e., use 'LR' to sort the LEAGUE by REGIONS, 'LS' to sort by 
  97.       SCORE, 'LN' for NETWORTH, and 'L#' for a simple numerical order. The same
  98.       basic principle applies to 'Realm' sort. 'RR' for 'Regions', 'RS' for
  99.       SCORE, 'RN' for NETWORTH, and 'R#' for alpha-order.
  100.  
  101. Three: Output file "toggles" -  BRECon will, by default, produce TWO output
  102.        files. These two files will have the names BRE_xxx.ANS/.ASC, where
  103.        xxx is equal to the Interplanetary League Number. For example, if you
  104.        are playing in, say, League 999, BRECon will produce BRE_999.ANS and
  105.        BRE_999.ASC, color and ASCII bulletins respectively. Use B# to gener-
  106.        ate NUMERIC format BULLETIN.LST files.
  107.               
  108.        However...
  109.  
  110.        You ALSO have the option of producing either a "BULLETIN.LST"-style
  111.        output file ONLY, -OR- producing BULLETIN.LST -AND- the BRE_xxx.ANS/
  112.        BRE_xxx.ASC files simultaneously.  Toggle these options with the key-
  113.        words 'BULL' or 'BOTH'. Specifying BULL will cause BRECon to produce
  114.        only a BULLETIN.LST file, whereas specifying BOTH (duh) produces both
  115.        types of files. I think you'll figure it out.
  116.  
  117.        (The ANSI/ASCII files will be created in the BRE directory specified
  118.        on the commandline with the "p=" parameter. BULLETIN.LST will be
  119.        created in the \GAME directory, where BRE expects it to be.)
  120.  
  121.        Oh yeah, separate your parameters with a SPACE. Parameters may occur
  122.        in any order, upper or lower case on the commandline.
  123.  
  124. **Important Note: If you wish, BRECon is capable of generating NUMERIC-FORMAT
  125.   BULLETIN.LST "indexes" - i.e., instead of typing the ENTIRE system name at 
  126.   the Bulletin prompt, you may instead type "BBS#". Remember, BRECon will NOT
  127.   produce bulletins for realms which have no players or data - therefore, the
  128.   numbers in the index file refer to the system's League Rank (determined by 
  129.   which Sort Type you specify), NOT the IP BRE System Number! Simply omit the
  130.   "B#" parameter from the commandline to generate FULL BBS system names in the
  131.   BULLETIN.LST file.
  132.  
  133.  
  134. -- RESOURCE.DAT
  135.  
  136.  
  137.   I did mention something about NOT having to edit BRE's RESOURCE.DAT file,
  138.   didn't I?  Well, I LIED. :>  Yup, fire up EDIT.COM and start typing.
  139.   Make sure to add the appropriate 'ExternalScoresAnsi blah blah blah' lines,
  140.   or your faithful BRE addicts wont get to see your pretty new BRECon screens.
  141.   (Consult the file RESOURCE.DOC included with BRE for more details on extern-
  142.   al file installation).
  143.  
  144.  
  145. -- Error Logging
  146.  
  147.    BRECon will produce an error log, "BRECON.ERR", in the event of any runtime
  148.    error.  I have endeavored to make this utility as bug-free as humanly 
  149.    possible, but, heh, things happen. The error log will list exactly what went
  150.    wrong when and if the program blows lunch. It's a standard text file, so
  151.    feel free to TYPE it or whatever.
  152.  
  153.    BRECon WILL NOT run if the INUSE.FLG file generated by BRE is present.
  154.    Multinoders, please keep this in mind.
  155.  
  156.  
  157. -- Complaint Department
  158.  
  159.   Please direct all complaints to >NUL.  Or, in lieu of that, Netmail the 
  160.   author, Mike Nichols (that's me!) at any of the following addresses:
  161.                             1:320/997  (Fido)
  162.                             30:203/0   (SGA-Net) 
  163.                             67:107/100 (PSI-Net, Alpha #28)
  164.                             50:590/110 (RGSNet)
  165.                             84:140/0   (RTSNet)
  166.                             85:861/130 (ITC)
  167.  
  168.   Or, call my BBS direct at (203)347-6997 or (203)347-0680. 300-28800bps.  
  169.  
  170.   Suggestions are appreciated.  This file may be Freq'ed using the "Magic
  171.   Name" BRECON from any of the above addresses, 24 hours a day.
  172.  
  173.  
  174. -- Suggestions? 
  175.  
  176.   PLEASE. I need 'em. Any input at all is welcome. Send your ideas via net-
  177.   mail to any of my addresses, or call my BBS is you have the time and leave
  178.   feedback to me.
  179.  
  180. -- Credits
  181.  
  182.   A BIG part of the crdit for BRECon deservedly goes out to Borland Inter-
  183.   national, producers of Borland Turbo Pascal 7.0, without which I'd have
  184.   much difficulty producing this program. (I hate DEBUG).  Here's the oblig-
  185.   atory line...
  186.  
  187.    Portions Copyright (c) 1983,92 Borland    (thanks, guys!)
  188.  
  189.  
  190.    My Co-SysOp, Ken Coomes, thought up the neato name, BRECon.
  191.  
  192.  
  193.  
  194. -- More Legal Babble
  195.  
  196.    I hereby release USE OF this program into the public domain, as FREEWARE.
  197.    However, I retain FULL rights of ownership to the source code. You MAY
  198.    NOT hex-edit, reverse-engineer, tamper with or otherwise modify this
  199.    executable.  Failure to comply with this restriction is punishable under
  200.    United States (and international) copyright laws.
  201.  
  202.  
  203. -- Revision History
  204.  
  205. 02/18/95- v0.093 Released - minor "tweaks". Added commas in all numeric
  206.           fields for easier reading. I.e: "1999" now appears as "1,999" and
  207.           so forth. Added capability to produce NUMERIC-FORMAT BULLETINS.
  208.           (Use the B# switch with either BULLONLY or BOTH parameters)
  209.  
  210. 11/13/94- v0.092 Released - dropped 286 requirement, now will run on 8088
  211.           or 8086 systems. MAJOR memory improvement! Now only needs around
  212.           256k free to sort ANY league, of ANY size. (up to BRE's internal
  213.           limit of 255 systems/25 realms per system) Drastically reduced
  214.           size of .EXE file (about 33%). No speed loss, even without 286
  215.           instruction set enabled.
  216.  
  217. 11/10/94- v0.091 Released - fixed minor liguistic errors in "Inactive Sys-
  218.           tems" listing. Added a short-'n-sweet HighWayWare "plug" to the
  219.           bulletins. (why not? everyone ELSE does :)
  220.  
  221. 11/05/94- v0.090 Released - Fixed runtime error 103 (file not open). BRECon
  222.           was trying to close TIMES.BR even if it didn't exist. (Due to a
  223.           league-wide reset) Ooops.  Made mods to output files to reflect
  224.           lack of "League-Wide" recon information.
  225.  
  226. 11/03/94- v0.080 Released - Stripped out useless system ID routines. Fixed
  227.           prompt color being set to dark grey in BULLETIN section of BRE
  228.           (if BULLETIN.LST was being produced). Also made BULLETIN.LST
  229.           screens clear the users screen before display. Reduced system
  230.           memory requirements by approx 2048 bytes.                
  231.  
  232. 10/20/94- v0.070 Released - Minor bug fixes: BRECon was not properly restoring
  233.           the screen color upon exit. (Thanks to Ed Stangler for telling me 
  234.           about this one)  Revamped help screen a bit. Changed the way runtime
  235.           errors are logged a tiny bit, too. Tweaked string handling a bit for
  236.           "strange" version names in ßeta versions of BRE, now will work with
  237.           these versions.
  238.  
  239. 10/19/94- Initial release (v0.060)
  240.  
  241. * Versions 0.01-0.05 never released to public.
  242.  
  243. [EOF]